package com.gitee.sop.website.dao.entity;

import com.gitee.fastmybatis.annotation.Column;
import com.gitee.fastmybatis.annotation.Pk;
import com.gitee.fastmybatis.annotation.PkStrategy;
import com.gitee.fastmybatis.annotation.Table;
import lombok.Data;

import java.time.LocalDateTime;

@Table(name = "help_doc", pk = @Pk(name = "id", strategy = PkStrategy.INCREMENT))
@Data
public class HelpDoc {
    /**
     * 主键ID，唯一标识每条帮助文档记录
     */
    private Long id;

    /**
     * 文档名称，显示用的标题或标签
     */
    private String label;

    /**
     * 排序字段，用于控制文档在列表中的显示顺序
     */
    private Integer sort;

    @Column(logicDelete = true)
    private Integer isDeleted;

    /**
     * 状态字段，表示文档是否启用
     * 1：启用，2：禁用
     */
    private Byte status;

    /**
     * 内容字段，存储文档的具体内容
     */
    private String content;

    /**
     * 内容类型，区分内容的格式
     * 1：Markdown，2：富文本
     */
    private Byte contentType;

    /**
     * 父级ID，用于构建文档的层级结构
     */
    private Long parentId;

    /**
     * 添加时间，记录文档首次创建的时间
     */
    private LocalDateTime addTime;

    /**
     * 更新时间，记录文档最后一次修改的时间
     */
    private LocalDateTime updateTime;

    /**
     * 创建人ID，记录创建该文档的用户ID
     */
    private Long addBy;

    /**
     * 修改人ID，记录最后一次修改该文档的用户ID
     */
    private Long updateBy;

}
